examples: add blecent and bleprph similar to mynewt-nimble apps #2807

maxikrie · 2024-10-30T23:02:12Z

Summary

These example apps create a BLE central and peripheral based on mynewt-nimBLE and work in companion. The apps are mostly based on their equivalents, which can be found at https://github.com/apache/mynewt-nimble/tree/master/apps

Impact

Testing

These were successfully tested on two nrf52840-dk boards.

These example apps create a BLE central and peripheral based on mynewt-nimBLE and work in companion. The apps are mostly based on their equivalents, which can be found at https://github.com/apache/mynewt-nimble/tree/master/apps

github-actions · 2024-10-30T23:02:31Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

cederom

Thank you @maxikrie :-) Please fix the code formatting issues: https://github.com/apache/nuttx-apps/actions/runs/11602988992/job/32309359887?pr=2807 :-)

acassis · 2024-10-31T13:27:05Z

examples/nimble_blecent/misc.c

+void
+print_bytes(const uint8_t *bytes, int len)


@maxikrie I think it can fit in a single line

acassis · 2024-10-31T13:27:34Z

examples/nimble_blecent/misc.c

+}
+
+void
+print_mbuf(const struct os_mbuf *om)


acassis · 2024-10-31T13:28:44Z

examples/nimble_blecent/misc.c

+    while (om != NULL) {
+        if (colon) {
+            printf(":");
+        } else {
+            colon = 1;
+        }
+        print_bytes(om->om_data, om->om_len);
+        om = SLIST_NEXT(om, om_next);
+    }


Please run the nxstyle or checkpatch.sh, it doesn't adhere to coding style, more info:
https://nuttx.apache.org/docs/latest/contributing/index.html

I will make changes and adhere to the standard. I am sorry that I didn't follow it immediately, it has been a while since my last pull request and I didn't see the documentation on contributing beforehand.

acassis · 2024-10-31T13:28:54Z

examples/nimble_blecent/misc.c

+}
+
+char *
+addr_str(const void *addr)


acassis · 2024-10-31T13:29:09Z

examples/nimble_blecent/misc.c

+}
+
+void
+print_uuid(const ble_uuid_t *uuid)


raiden00pl · 2024-10-31T13:42:18Z

why not modify the current nimble peripheral example (https://github.com/apache/nuttx-apps/blob/master/examples/nimble/nimble_main.c)? do we need 2 different examples for this?

maxikrie · 2024-11-01T17:11:01Z

why not modify the current nimble peripheral example (https://github.com/apache/nuttx-apps/blob/master/examples/nimble/nimble_main.c)? do we need 2 different examples for this?

I was debating this with myself. As stated, I based them on the mynewt-nimble apps and hence the peripheral is quite different from the existing one. I could, of course, modify the existing one losing the tight connection to the mynewt-nimble app. The other options are maintaining the existing one along side my contribution for legacy reasons, or purging the existing one (my preference). What do you think? @raiden00pl

raiden00pl · 2024-11-01T17:45:48Z

@maxikrie The Mynewt coding standard is far from the NuttX coding standard, so the code will be a lot different anyway. Keeping 2 examples demonstrating the same functionality seems pointless to me. The easiest thing to do would be to change the name of existing examples/nimble to examples/nimble_bleprph (or nimble_prph) and add all your changes there.
Or you can delete examples/nimble but then you will have more work to adapt the Mynewt code to the NuttX coding standard.

examples/nimble_blecent/Kconfig

cederom · 2024-11-02T15:06:33Z

CI checkpatch is now fixed, CI restarted :-)

cederom · 2024-11-02T15:08:56Z

Source code still needs reformat, @maxikrie please take a look at:

maxikrie · 2024-11-23T11:26:37Z

@cederom Is there a way to check whether my changes will pass the check before committing? I read the documentation on pre-commit, but it seems that this only applies to the nuttx repository - at least this repository is missing the required .pre-commit-config.yaml.

I have installed pre-commit in the nuttx repository and tested it on branch nuttx-12.7.0, where everything is fine. I then naively tried from within the nuttx repository:
pre-commit run --files ../apps/*
which gives all sorts of strange errors.

xiaoxiang781216 · 2024-11-23T19:04:58Z

@cederom Is there a way to check whether my changes will pass the check before committing? I read the documentation on pre-commit, but it seems that this only applies to the nuttx repository - at least this repository is missing the required .pre-commit-config.yaml.

I have installed pre-commit in the nuttx repository and tested it on branch nuttx-12.7.0, where everything is fine. I then naively tried from within the nuttx repository: pre-commit run --files ../apps/* which gives all sorts of strange errors.

please run the following command to check the style:
../nuttx/tools/checkpatch.sh -g HEAD~...HEAD

acassis · 2024-12-20T14:43:40Z

ping @maxikrie

maxikrie · 2025-01-09T11:01:44Z

I fixed the formatting issues and fixed an error in the Makefile (I previously had only tested the CMake build), but there are again failed checks. Can somebody check? I am not sure what to make of them.. @xiaoxiang781216 @cederom

cederom · 2025-01-09T11:32:13Z

Thank you @maxikrie :-)

Most of the formatting issues detected by CI are in the codebase already:
https://github.com/apache/nuttx-apps/actions/runs/12679172534/job/35340025084?pr=2807

Looks like these still needs an update?

the ones with comment.
builtin/builtin_list.c.
canutils/candump/candump.c

maxikrie · 2025-01-09T16:17:36Z

I am not sure, should I look into this? I am just checking since I didn't touch these and they didn't appear to be an issue when I run the nxstyle tool. I want to make sure this is not an issue with the CI.

raiden00pl · 2025-01-10T10:03:08Z

examples/nimble_blecent/misc.c

+  return buf;
+}
+
+void print_uuid(const ble_uuid_t *uuid)


all pointers in must be marked with FAR: FAR const ble_uuid_t *uuid)

raiden00pl · 2025-01-10T10:05:03Z

examples/nimble_blecent/misc.c

+/**
+ * Utility function to log an array of bytes.
+ */


NuttX doesn't use Doxygen comments. This and all similar should be converted to:

/* Utility function to log an array of bytes */

raiden00pl · 2025-01-10T10:07:53Z

examples/nimble_bleprph/nimble_bleprph_main.c

+ * @param event                 The type of event being signalled.
+ * @param ctxt                  Various information pertaining to the event.
+ * @param arg                   Application-specified argument; unuesd by
+ *                                  bleprph.
+ *
+ * @return                      0 if the application successfully handled the
+ *                                  event; nonzero on failure.  The semantics
+ *                                  of the return code is specific to the
+ *                                  particular GAP event being signalled.
+ */


doxygen is not allowed. The correct comment block for function looks like this:

/**************************************************************************** * Private Functions ****************************************************************************/ /**************************************************************************** * Name: <Static function name> * * Description: * Description of the operation of the static function. * * Input Parameters: * A list of input parameters, one-per-line, appears here along with a * description of each input parameter. * * Returned Value: * Description of the value returned by this function (if any), * including an enumeration of all possible error values. * * Assumptions/Limitations: * Anything else that one might need to know to use this function. * ****************************************************************************/

raiden00pl · 2025-01-10T10:12:04Z

does anyone have any idea why CI is returning nxstyle errors unrelated to PR content?

What is this Unchanged files with check annotations Preview ? any ideas @lupyuen @simbit18 @xiaoxiang781216 ?

lupyuen · 2025-01-10T10:33:11Z

@maxikrie Could you try rebasing with the latest master branch? The branch looks rather old (Oct 30).

Also the CI Check seems to be running OK for the latest builds. Thanks!

https://github.com/apache/nuttx-apps/actions/workflows/check.yml

github-actions bot added the Area: Examples label Oct 30, 2024

github-actions bot added the Size: XL label Oct 30, 2024

This was referenced Oct 30, 2024

[HELP] nimBLE central (companion to examples/nimble) on a nrf52840-dk apache/nuttx#14012

Closed

Add BLE support for esp32s3 apache/nuttx#12685

Closed

cederom requested changes Oct 30, 2024

View reviewed changes

acassis reviewed Oct 31, 2024

View reviewed changes

raiden00pl reviewed Nov 1, 2024

View reviewed changes

examples/nimble_blecent/Kconfig Show resolved Hide resolved

maxikrie added 2 commits January 8, 2025 20:40

Fix formatting

43cf440

Fix Makefiles

0cf8da4

raiden00pl reviewed Jan 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

examples: add blecent and bleprph similar to mynewt-nimble apps #2807

examples: add blecent and bleprph similar to mynewt-nimble apps #2807

maxikrie commented Oct 30, 2024

github-actions bot commented Oct 30, 2024

cederom left a comment

acassis Oct 31, 2024

acassis Oct 31, 2024

acassis Oct 31, 2024

maxikrie Nov 1, 2024

acassis Oct 31, 2024

acassis Oct 31, 2024

raiden00pl commented Oct 31, 2024

maxikrie commented Nov 1, 2024 •

edited

Loading

raiden00pl commented Nov 1, 2024 •

edited

Loading

cederom commented Nov 2, 2024

cederom commented Nov 2, 2024

maxikrie commented Nov 23, 2024 •

edited

Loading

xiaoxiang781216 commented Nov 23, 2024

acassis commented Dec 20, 2024

maxikrie commented Jan 9, 2025

cederom commented Jan 9, 2025

maxikrie commented Jan 9, 2025

raiden00pl Jan 10, 2025

raiden00pl Jan 10, 2025

raiden00pl Jan 10, 2025

raiden00pl commented Jan 10, 2025 •

edited

Loading

lupyuen commented Jan 10, 2025

examples: add blecent and bleprph similar to mynewt-nimble apps #2807

Are you sure you want to change the base?

examples: add blecent and bleprph similar to mynewt-nimble apps #2807

Conversation

maxikrie commented Oct 30, 2024

Summary

Impact

Testing

github-actions bot commented Oct 30, 2024

cederom left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raiden00pl commented Oct 31, 2024

maxikrie commented Nov 1, 2024 • edited Loading

raiden00pl commented Nov 1, 2024 • edited Loading

cederom commented Nov 2, 2024

cederom commented Nov 2, 2024

maxikrie commented Nov 23, 2024 • edited Loading

xiaoxiang781216 commented Nov 23, 2024

acassis commented Dec 20, 2024

maxikrie commented Jan 9, 2025

cederom commented Jan 9, 2025

maxikrie commented Jan 9, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raiden00pl commented Jan 10, 2025 • edited Loading

lupyuen commented Jan 10, 2025

maxikrie commented Nov 1, 2024 •

edited

Loading

raiden00pl commented Nov 1, 2024 •

edited

Loading

maxikrie commented Nov 23, 2024 •

edited

Loading

raiden00pl commented Jan 10, 2025 •

edited

Loading